ci: skip the public-API gate on docs/site-only changes#34
Merged
Conversation
api-check.yml ran on every PR, including pure markdown/docs changes that cannot alter the Kotlin public-API surface (the jobs only diff the committed *.api / *.klib.api dumps). Add the same paths-ignore filter build.yml already uses so docs/site-only PRs skip both the api-check (macOS) and api-parity jobs. A PR that also touches code/build files still runs the full gate. Safe because main is unprotected: no required status check exists that a path-filtered skip could leave permanently pending. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
api-check.ymlran on every PR — including pure docs/markdown changes (like the Code of Conduct in #33) that cannot alter the Kotlin public-API surface. The two jobs (api-checkon macOS,api-parityon ubuntu) only diff the committed*.api/*.klib.apidumps; they never run library code, so a.mdedit can't affect their result.This adds the same
paths-ignorefilterbuild.ymlalready uses, so docs/site-only PRs skip the API gate too — consistent with the existing docs-skip policy (#31).Why it's safe:
mainis unprotected, so there's no required status check that a path-filtered skip could leave permanently "pending" (the usualpaths-ignoregotcha on required checks doesn't apply here).Scope unchanged for real changes: any PR that also touches code/build files still runs the full gate.
workflow_dispatchstays unfiltered for manual runs.🤖 Generated with Claude Code